<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dp12: xdp_tx_audio_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dp12
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdp__tx__audio__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdp_tx_audio_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Contains a design example using the <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> driver (operating in TX mode) to train the main link and to display video. </p>
<p>In this example application, the sequence to enable audio is illustrated.</p>
<dl class="section note"><dt>Note</dt><dd>This example requires an audio source such as an S/PDIF instance to be part of the hardware system. See XAPP1178 for reference. </dd>
<dd>
This example requires that the audio enable configuration parameter for DisplayPort be turned on when creating the hardware design. </dd>
<dd>
For this example to output audio, the user will need to implement initialization of the system (Dptx_PlatformInit), configuration of the audio source (Dptx_ConfigureAudioSrc) and, depending on the hardware system, will need to implement sending of an info frame (Dptx_AudioSendInfoFrame). See XAPP1178 and the IP documentation for reference. </dd>
<dd>
For this example to display output, after training is complete, the user will need to implement configuration of the video stream source in order to provide the DisplayPort core with input (Dptx_StreamSrc* - called in <a class="el" href="xdp__tx__example__common_8c.html" title="Contains a design example using the XDp driver (operating in TX mode). ">xdp_tx_example_common.c</a>). See XAPP1178 for reference. </dd>
<dd>
The functions Dptx_PlatformInit and Dptx_StreamSrc* are declared extern in <a class="el" href="xdp__tx__example__common_8h.html" title="Contains a design example using the XDp driver (operating in TX mode). ">xdp_tx_example_common.h</a> and are left up to the user to implement. The functions Dptx_ConfigureAudioSrc and Dptx_AudioSendInfoFrame are present in this file and are also left for the user to implement.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   als  01/20/15 Initial creation.
5.1   ms   01/23/17 Added xil_printf statement in main function to
                    ensure that "Successfully ran" and "Failed" strings
                    are available in all examples. This is a fix for
                    CR-965028.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aed37a94e3e46be308096977d47387cd9"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdp__tx__audio__example_8c.html#aed37a94e3e46be308096977d47387cd9">Dptx_AudioExample</a> (<a class="el" href="struct_x_dp.html">XDp</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:aed37a94e3e46be308096977d47387cd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main entry point for the audio example using the <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> driver.  <a href="#aed37a94e3e46be308096977d47387cd9">More...</a><br/></td></tr>
<tr class="separator:aed37a94e3e46be308096977d47387cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdp__tx__audio__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the main function of the <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> audio example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aed37a94e3e46be308096977d47387cd9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 Dptx_AudioExample </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dp.html">XDp</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The main entry point for the audio example using the <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> driver. </p>
<p>This function will set up audio, initiate link training, and a video stream will start being sent over the main link.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> instance. </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the unique device ID of the DisplayPort TX core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the system was set up correctly and link training was successful.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdp__tx__example__common_8c.html#aa048b03b5dc7408a4dd444f631eb6f30">Dptx_Run()</a>, and <a class="el" href="xdp__tx__example__common_8c.html#a7890171f707168d57a1ee86a34eede68">Dptx_SetupExample()</a>.</p>

<p>Referenced by <a class="el" href="xdp__tx__audio__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the main function of the <a class="el" href="struct_x_dp.html" title="The XDp instance data. ">XDp</a> audio example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the audio example finished successfully.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xdp__tx__audio__example_8c.html#aed37a94e3e46be308096977d47387cd9">Dptx_AudioExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
